# The contents of this file are subject to the Common Public Attribution
# License Version 1.0. (the "License"); you may not use this file except in
# compliance with the License. You may obtain a copy of the License at
# http://code.reddit.com/LICENSE. The License is based on the Mozilla Public
# License Version 1.1, but Sections 14 and 15 have been added to cover use of
# software over a computer network and provide for limited attribution for the
# Original Developer. In addition, Exhibit A has been modified to be consistent
# with Exhibit B.
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
# the specific language governing rights and limitations under the License.
#
# The Original Code is reddit.
#
# The Original Developer is the Initial Developer.  The Initial Developer of
# the Original Code is reddit Inc.
#
# All portions of the code written by reddit are Copyright (c) 2006-2015 reddit
# Inc. All Rights Reserved.
###############################################################################

class TicketProvider(object):
    """Provider for handling support tickets interactions.

    """
    
    def build_ticket_url_from_id(self, ticket_id):
        """
        Creates a URL to access a ticket based on URL

        `ticket_id` the unique identifier for the ticket

        Returns a URL to the ticket
        """
        raise NotImplementedError
        
    def create(self):
        """Creates a new support ticket with the provider. 

        Parameters may vary depending on the provider you use.

        The return value should be a JSON object of the created ticket.
        """
        raise NotImplementedError

    def get(self, ticket_id):
        """Gets an existing ticket from the provider.

        `ticket_id` is a unique identifier dor the ticket.

        The return value should be a JSON object of the created ticket.
        """
        raise NotImplementedError

    def update(self):
        """Updates the ticket with the provider

        Parameters may vary depending on the provider you use.

        The return value should be a JSON object of the updated ticket.
        """
        raise NotImplementedError
